Skip to main content
Version: 9.2

Deployment Jobs

A deployment job executes the type of deployment specified by one or more deployment definitions against one or more target servers. Deployment jobs consist of blocks of instructions, with each block configuring the deployment of one deployment definition to any number of users on one destination server. That enables you to use one deployment job to deploy multiple applications to as many users as necessary, on multiple environments. Deployment jobs require at least one block.

Before You Begin​

Verify that the desired Deployment Definition has been created.

Tip: If you intend to give access to an application to all users from one organization, in the same environment, consider making the application public instead of deploying it to all users. This prevents the application from being replicated into copies of the original.

Create a Deployment Job​

  1. In Qrvey Admin, select the Content Deployment icon in the left navigation panel to display the Deployment Jobs tab.

  2. Select Create Job to open the Deployment Job page.

  3. In the fields provided, enter a name and description to replace the placeholder text.

  4. Deployment jobs are made up of one or more blocks that combine configuration information. In Block 1, use the dropdown lists to group the following combination:

    • Deployment Definition - Select an existing deployment definition.
    • Destination Server - Select the target server for the deployment.
    • Users - Select one or more target user accounts for the deployed application.

The page updates to display additional sections containing details about the deployment definition (Definition Summary and Users sections). To display additional information about the entries in a section, select its Details link.

  1. Define parameter tokens.
  2. Define content tokens.

To add a new block, select Add Block and repeat these steps.

Tip: To deploy one application to several destination servers, create a block for each server.

Parameter Tokens​

The deployment definition does not specify the target application. That information is defined in the deployment job. This separation enables you to use one deployment definition to update multiple target applications for any number of users. To take advantage of this capability, you must use parameter tokens, user-defined parameters that can replace any value and be configured for each recipient when creating the deployment job. The parameter token uses the following syntax:

{{tokenName}}

For example:

  • You can copy the same application to multiple instances, but with different options specified for each instance.
  • You can use different connection strings in each destination application, depending on the recipient user or tenant.

You can replace any value with a parameter token by typing your own token name inside two curly brackets ({}). When you enter the first bracket, the system provides contextual suggestions for naming the token. For example, if the source application uses a connection to a database that is used for development and testing, and each copied destination application must be connected to a separate production database, you can replace the host URL of the source application with a parameter token like {{hostURL}}. You can also accept a suggested token name such as {{connection.host_url}}. You can repeat this process to set the username and password of the connection to a token.

Parameter Token Use Case​

You need to deploy an application that was created in a staging environment into several tenant accounts in a production environment. The source application is connected to a sample database that is used for development purposes, but each destination environment contains its own database. To achieve this goal, replace the following attributes of the database connection with parameter tokens:

  • Host URL: {{host-url}}
  • User Name: {{db-username}}
  • Password: {{prodPassword}}

When this deployment definition is used in a deployment job, the deployment job resolves the appropriate values for each token and creates the database connections.

Define a Parameter Token​

  1. In the deployment job, create or edit a block to display the Deployment Definition Summary section.
  2. Locate the parameter token to configure, and select its Configure link. A configuration dialog displays.
  3. Enter a value for each parameter token. To use the same value for multiple users, select those users, select the Bulk Edit link, and enter the common value in the box provided.
  4. When finished, select OK.
  5. To review the details for a user, select its Details link.

Content Tokens​

A content token is a system-generated parameter that is automatically created for a value that needs to be resolved for each recipient. Created in the deployment definition, the content token is resolved when the deployment job runs. While it uses a {{token}} syntax like the parameter token, this token is assigned by the system and applies to an objects. instead of a value. It identifies things like “application” and “connection”, rather than “application name” and “connection’s username”.

Content Token Use Case​

If a deployment definition is created to update an application, the system assigns the application the content token, {{ user.application }}. Later, in the deployment job, if multiple users are picked as recipients of the deployed application, the system resolves the content token for each user. This enables the deployment job to update the application for each of the recipient users.

After determining which target application of each user is going to be updated, all of the other objects which depend on the selected target application, such as the connections, datasets, and so on, have to be configured.

Define a Content Token​

  1. In the deployment job, display the Deployment Definition Summary section.

  2. Use the search field to locate the content token, then select its Configure link.

    • If a Configure link is disabled, one or more of its prerequisite content tokens has not been configured.
    • If a deployment job only deploys new content, there are no content tokens to configure.

  3. Configure the destination content using the options provided. You need to map the Content Token to existing shared data on the destination server.

  4. When finished, select OK. The User Destination Content table refreshes to display the mapping.

Run a Deployment Job​

  1. In Qrvey Admin, select the Content Deployment icon in the left navigation panel to display the Deployment Jobs tab.

  2. From the table, select the corresponding job's options menu, then select Edit.

  3. Configure content tokens, if necessary.

  4. Configure parameter tokens, if necessary.

  5. Review the deployment definition by selecting its Details link.

  6. Select Deploy.

  7. Select one of the following options for handling failures:

    • Skip the installation for the user that failed and continue installing the remaining users.
    • Deploy anyway for that user despite the broken or faulty assets.

  8. Select OK to run the deployment.

Note: You cannot modify a deployment job after it runs.

Delete a Deployment Job​

To delete an existing deployment job, select its corresponding options menu from the deployment job list, then select Delete.